/*******************************************************************************
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *  
 * Copyright (c) 2011 Michael Chan.
 ******************************************************************************/
package com.google.code.solrdimension.queryresponse;

import org.apache.solr.client.solrj.response.QueryResponse;

import com.google.code.solrdimension.config.DimensionConfigWrapper;
import com.google.code.solrdimension.core.DimensionQuery;
import com.google.code.solrdimension.core.DimensionResponse;
import com.google.code.solrdimension.parsers.exception.SolrDimensionException;

/**
 * Translate from a SOLR {@link QueryResponse} object to a {@link DimensionQuery} object
 * @author mhc
 *
 */
public interface QueryResponseInterpreter {
    
    /**
     * The method responsible for the translation. Note that this method only interpret the 
     * 
     * "Facet" parts of the responses, i.e
     *  {@link QueryResponse#getFacetFields()}, {@link QueryResponse#getFacetQuery()}
     * 
     * 
     * 
     * @param solrQueryResponse
     *          The {@link QueryResponse} from SOLR
     * @param config
     *          {@link DimensionConfigWrapper} 
     * @return
     *        {@link DimensionResponse}
     */
    public DimensionResponse interpretQueryResponse(QueryResponse solrQueryResponse, DimensionConfigWrapper config) throws SolrDimensionException;
    
}
